Skip to content

Updating an existing Rate Card Set Version

Request

A Rate Card Set Version can only be modified when the effective date is in the future, or when it is not yet published.

This endpoint returns structured Rate Card Set Version objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the rate_card_set_versions top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • rate_card_set (RateCardSet) - The Rate Card Set this version belongs to.
  • rate_card_versions (RateCardVersion) - The Rate Card Version of each Rate Card defined on the Rate Card Set.
Bodyapplication/jsonrequired
rate_card_set_versionobject
{
  "rate_card_set_version": {
    "effective_date": "2019-08-24"
  }
}

Responses

Rate Card Set Version has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
rate_card_set_versionsobject
rate_card_setsobject
rate_card_versionsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "rate_card_set_versions": {
    "property1": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    },
    "property2": {
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "effective_date": "2019-08-24",
      "rate_card_set_id": "string",
      "rate_card_version_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "used_currencies": [
        "string"
      ]
    }
  },
  "rate_card_sets": {
    "property1": {
      "account_default": true,
      "active_currencies": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "default_currencies": [
        "string"
      ],
      "destroyable": true,
      "rate_card_ids": [
        "string"
      ],
      "rate_card_set_version_ids": [
        "string"
      ],
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ]
    },
    "property2": {
      "account_default": true,
      "active_currencies": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "default_currencies": [
        "string"
      ],
      "destroyable": true,
      "rate_card_ids": [
        "string"
      ],
      "rate_card_set_version_ids": [
        "string"
      ],
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_group_ids": [
        "string"
      ]
    }
  },
  "rate_card_versions": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "default_rate": 0,
      "rate_card_id": "string",
      "rate_card_role_ids": [
        "string"
      ],
      "rate_card_set_version_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}